HPD Retrieval API

URL: POST /api/practitionerrolequery/v1/{{SLUG_NAME}}

Where:

• SLUG_NAME for PractitionerRole can be:
  • hpd-practitioner-role-active-verbose - Active Practitioner Roles Only
  • hpd-practitioner-role-active-verbose-expiring-30-days - APC Ends in 30 days
  • hpd-practitioner-role-all-verbose - All Practitioner Roles

Note:

1. practitionerRoleQuery is a required field - but you can pass in empty queryCriteria (just so the query engine works)
2. organisationQuery is optional - this is to query the organisations to be used as a filter for the practitioner role (i.e. for each matching organisation found as part of this query, this will be used to find practitioner roles in that organisation)
3. locationQuery is optional - this is to query the locations to be used as a filter for the practitioner role (i.e. for each matching location found as part of this query, this will be used to find practitioner roles in that location)

SAMPLE USE CASE:

Find all practitionerRoles where practitioner CPN is 95ZZHW, sort in ascending order

POST /api/practitionerRoleQuery/v1/hpd-practitioner-role-all-verbose
{
"practitionerRoleQuery": {
"operator": "AND",
"queryGroup": [],
"queryCriteria": [
{
"name": "cpn",
"operator": "STRINGEQUALS",
"value": "95ZZHW"
}]
},
"pageSize": 10,
"queryResultType": "FhirBundleAttribute",
"sortBy": "cpn",
"sortDirection": "ASC"
}

Find all practitionerRoles in location F00002-B

POST /api/practitionerRoleQuery/v1/hpd-practitioner-role-all-verbose
{
"practitionerRoleQuery": {
"operator": "AND",
"queryGroup": [],
"queryCriteria": []
},
"locationQuery": {
"operator": "AND",
"queryGroup": [],
"queryCriteria": [
{
"name": "hpiId",
"operator": "STRINGEQUALS",
"value": "F00002-B"
}
]
},
"pageSize": 10,
"queryResultType": "FhirBundleAttribute",
}

Find all practitionerRoles where cpn is 95ZZHW and organisation email address is Updgrade@email.co.nz

POST /api/practitionerRoleQuery/v1/hpd-practitioner-role-all-verbose
{
"practitionerRoleQuery": {
"operator": "AND",
"queryGroup": [],
"queryCriteria": [
{
"name": "cpn",
"operator": "STRINGEQUALS",
"value": "95ZZHW"
}
]
},
"organizationQuery": {
"operator": "AND",
"queryGroup": [],
"queryCriteria": [
{
"name": "allTelecom",
"operator": "CONTAINS",
"value": "Updgrade@email.co.nz"
}
]
},
"pageSize": 10,
"queryResultType": "JsonAttribute"
}